[POST] /metrics/download-page

Objective:

Use this service to download the session page and all related information obtained from it. Each call to this service returns a maximum of 1,000 records and a token ( 1-day lifetime).

Parameters:

• pageToken: Page token, is obtained from metrics/download.

CURL Example:

curl -X POST --header ‘Content-Type: application/json’ --header ‘Accept: application/json’ --header ‘access-token: <ACCESS-TOKEN>’ ‘https://go.botmaker.com/api/v1.0/metrics/download-page?pageToken=2fb2085a-e5d8-4000-88d7-6380bb475db7’

Response Structure

• fromDate [timestamp] Date when the first session in the list was generated | 2021-01-01T00:00:00.001Z.
• pageRows [number] Number of page columns | 21.
• sessions [array] Session list.
  • variables [array] Variable list.
    • varKey:varValue [type] Active variables in the session | “botmakerenvironment:DEVELOPMENT”.
  • sessionDate [timestamp] Date when the session was generated | “2021-01-20T13:56:59.184Z”
  • botMessages [number] Bot messages | 23.
  • userHasTalked [boolean] Checks if the user spoke | “true”
  • topics [array] Topic list
    • topicKey [string] Topics interacted with in the session “Identity”.
  • sessionId [string] Session ID | “YPU6L8F1SA7Y8SHSVH17_2021-01-20T13:56:59.184Z”.
  • platformContactId [string] Platform ID | “SBBZ2F73DL-5572714M6YG3Y5V2S0DO1L3QZMD”.
  • userCreationTime [timestamp] Date when the user was first generated | “2021-01-01T00:00:00.001Z”.
  • sessionMessages [array] List of session messages
    • creationTime [timestamp] Date when the message was created | “2021-01-20T15:03:30.535Z”.
    • messageId [string] Message ID, for unique identification | “83T21XKVJGQ1EZ1L1NCH”.
    • messageType [string] Type of message | “Text”.
    • message [string] Message| “test”.
    • msgFrom [string] Where the message comes from | “user”.
    • imagesUrls [string] URL of the Botmaker storage where the image was saved | “null”.
    • audiosUrls [string] URL of the Botmaker storage where the audio was saved | “null”.
    • videosUrls [string] URL of the Botmaker storage where the video was saved | “null”.
    • filesUrls [string] URL of the Botmaker storage where the file was saved | “null”.
    • ruleName [string] Name of executed intent | “Home shopping”.
    • operator [string] Name of the agent who interacted | “Nicolás V.”
    • queue [string] Name of service queue with which they interacted | “Test_Botmaker”.
  • customerId [string] Customer ID for unique identification | “YPU6L8F1SA7Y8SHSVH17”.
  • userMessages [number] Number of user messages| 23.
  • operatorMessages [number] Number of agent messages | 2.
  • sessionMessagesQty [number] Number of session messages | 46.
  • sessionStartingCause [string] Reason for login | “Organic”.
  • channelId [string] Chanel IDl | “testbot-webchat-null-SBBZ2F73DL”.
  • conversation [string] Conversation URL | “https://go.botmaker.com/#/chats/YPU6L8F1SA7Y8SHSVH17”.
  • events [array] Event list
    • eventName [string] Event name | “put-var”.
    • eventCreationTime [timestamp] Date of event creation | “2021-01-20T14:49:09.701Z”.
    • info [array] [
      • name [string] Name | “key”.
      • value [string] Value | “test@botmaker.io-1498255647287”.
• toDate [timestamp] Time when the last session in the list was generated | 2021-01-01T00:00:00.001Z.
• hasMore [boolean] Verify if it has more | true.
• totalRows [number] Total number of columns | 200.

Ejemplo JSON:

{“pageRows”:21,“sessions”:[{“variables”:[“botmakerenvironment:DEVELOPMENT”,"webchathostdomain:go.bot